Task

ListTask

ListTask接口列出当前project下所有的task

请求语法

GET /accounts/<account_name>/projects/<project_name>/tasks/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称 类型 是否必须 描述
from integer 否 查询开始时间点（按照Task开始时间算，精度为秒，从1970-1-1 00：00：00 UTC计算起的秒数）。默认值是24小时前
to integer 否 查询结束时间点（按照Task开始时间算，精度为秒，从1970-1-1 00：00：00 UTC计算起的秒数）。默认值是当前时刻
offset integer 否 返回记录的起始位置，默认值为0
size integer 否 每页返回最大条目，默认500(默认值)
taskname string 否 用于过滤的Task名称
status string 否 用于过滤的Task 状态
reverse bool 否 是否按开始时间从过去到现在排序（默认按开始时间从现在到过去排序）

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

ListTask请求成功，其响应的Body会包括当前project下所有task列表，具体格式如下：

属性名称 类型 描述
count int 返回的Task数目
total int Task总数
task_list list Task列表
task_id string Task的唯一标识
task_name string Task的名称
user string 启动Task的用户
status string Task的状态
workflow_name string 该Task对应的Workflow的名字
workflow_version int 该Task对应的Workflow version
job_number int 该Task对应的job数量
process string 该Task的完成进度
startTime DateTime Task开始时间
endTime DateTime Task结束时间

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码。

HTTP状态码 错误码 错误信息 描述
404 TaskNotFound List tasks failed 获取任务列表失败

请求示例

GET /accounts/genedock/projects/default/tasks/?offset=10&size=3 HTTP/1.1

Header:

Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:dXNGSvFNrAyQj98uiOeWtkCTgPQ=
Content-Length: 44
Date: Thu, 19 May 2016 03:39:31 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0
Content-Type: application/json
x-gd-apiversion: 1.0

响应示列

HTTP/1.1 200 OK

Header：

Content-Length: 896
x-gd-requestid: 573d35731315e000191b2bad
Date: Thu, 19 May 2016 03:39:31 GMT
Connection: close
Content-Type: application/json;charset=utf-8
Server: nginx/1.4.6

Body：
{
    "count": 3,
    "total": 57,
    "task_list": [
        {
            "status": "success",
            "user": "******",
            "task_id": "573c35911315e0000159c5f3",
            "workflow_name": "bam_stats",
            "startTime": 1463563665.306988,
            "endTime": 1463564474.46183,
            "workflow_version": 1,
            "task_name": "test_active_workflow1463563664",
            "process": "3/3",
            "job_number": 3
        },
        {
            "status": "success",
            "user": "*****",
            "task_id": "573c34ab1315e00001b13d8f",
            "workflow_name": "bam_stats",
            "startTime": 1463563436.079809,
            "endTime": 1463564252.129524,
            "workflow_version": 1,
            "task_name": "test_active_workflow1463563435",
            "process": "4/4",
            "job_number": 4
        },
        {
            "status": "success",
            "user": "*****",
            "task_id": "573c34271315e00001b13d8c",
            "workflow_name": "bam_stats",
            "startTime": 1463563304.169805,
            "endTime": 1463564061.27564,
            "workflow_version": 1,
            "task_name": "test_active_workflow1463563303",
            "process": "4/4",
            "job_number": 4
        }
    ],
    "msg": "List task successfully!",
    "msg_chs": "任务列出成功"
}

GetTask

获取指定Task的信息

请求语法


GET /accounts/<account_name>/projects/<project_name>/tasks/<task_id>/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称 类型 是否必须 描述
task_id string 是 Task的唯一标识。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

GetTask请求成功，其响应的Body会包括以下内容，具体格式如下：

属性名称 类型 描述
task_id string Task的唯一标识
task_name string Task的名称
user string 启动Task的用户
status string Task的状态
parameters object 配置Task时所填写的参数
workflow_name string 该Task对应的Workflow的名字
workflow_version int 该Task对应的Workflow 版本号
job_number int 该Task对应的job数量
process string 该Task的完成进度
startTime DateTime Task开始时间
endTime DateTime Task结束时间

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码。

HTTP状态码 错误码 错误信息 描述
404 TaskNotFound Task{task_id}not exist 获取任务详情失败

请求示例

GET /accounts/genedock/projects/default/tasks/58be55886d3fa44957e3f0c1/ HTTP/1.1

Header:

Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:HCFd9rprrrrIZohR/u75a50GsoE=
Date: Thu, 19 May 2016 03:47:25 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0
Content-Type: application/json

响应示列

HTTP/1.1 200 OK

Header：

Content-Length: 190
x-gd-requestid: 573d374d1315e000181b2bad
Server: nginx/1.4.6
Connection: close
Date: Thu, 19 May 2016 03:47:25 GMT
Content-Type: application/json;charset=utf-8

Body：
{
  "status": "stopped",
  "parameters": {
    ...
  },
  "task_id": "58be55886d3fa44957e3f0c1",
  "process": "1/2",
  "workflow_name": "586365ccc21f96001036060f",
  "startTime": 1488868745.607261,
  "user": "admin",
  "task_name": "hello_2017_03_7_14_35_07",
  "endTime": 1488869769.840978,
  "job_number": 2,
  "workflow_version": 1
}

StopTask

停止指定Task. 只允许停止状态为running的Task.

请求语法

PUT /accounts/<account_name>/projects/<project_name>/tasks/<task_id>/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Content-Type: application/json
Content-Length: <Content Length>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称 类型 是否必须 描述
task_id string 是 Task的唯一标识。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

请求成功返回200.

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码 错误码 错误信息 描述
404 TaskNotFound Stop task failed 停止任务失败

请求示例

PUT /accounts/genedock/projects/default/tasks/5715ab2a5d02d91829f57fb9/ HTTP/1.1

Header:

Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:sGcCMp5zwMs1DpN/rhU1QumP15Y=
Connection: close
Date: Thu, 19 May 2016 03:59:59 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0

响应示例

HTTP/1.1 200 OK

Header：

Content-Length: 190
x-gd-requestid: 573d3a3f1315e000191b2bae
Server: nginx/1.4.6
Connection: close
Date: Thu, 19 May 2016 03: 59: 59 GMT
Content-Type: application/json;charset=utf-8

DeleteTask

删除指定Task. 只允许删除状态为success/failed/stopped的Task.

请求语法

DELETE /accounts/<account_name>/projects/<project_name>/tasks/<task_id>/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Content-Type: application/json
Content-Length: <Content Length>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称 类型 是否必须 描述
task_id string 是 Task的唯一标识。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

请求成功返回200.

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码 错误码 错误信息 描述
404 TaskNotFound Deleted task failed 删除任务失败

请求示例

DELETE /accounts/genedock/projects/default/tasks/5715ab2a5d02d91829f57fb9/ HTTP/1.1

Header:

Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:sGcCMp5zwMs1DpN/rhU1QumP15Y=
Connection: close
Date: Thu, 19 May 2016 03:59:59 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0

响应示例

HTTP/1.1 200 OK

Header：

Content-Length: 190
x-gd-requestid: 573d3a3f1315e000191b2bae
Server: nginx/1.4.6
Connection: close
Date: Thu, 19 May 2016 03: 59: 59 GMT
Content-Type: application/json;charset=utf-8

ListJob

列出指定task下所有的job

请求语法

GET /accounts/<account_name>/projects/<project_name>/tasks/<task_id>/jobs/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

无特定请求参数

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

ListJob请求成功，其响应的Body会包括当前task下所有jobs列表，具体格式如下

属性名称 类型 描述
jobs list Job列表
job_id string Job的唯一标识
app_name string Job使用app的名称
status string Job的状态
startTime DateTime Job开始时间
endTime DateTime Job结束时间
deps list Job依赖的jobs
task_id string 该Job对应的Task的唯一标识

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码。

HTTP状态码 错误码 错误信息 描述
404 TaskNotFound List job failed 获取作业列表失败

请求示例

GET /accounts/genedock/projects/default/tasks/573c35911315e0000159c5f3/jobs/ HTTP/1.1

Header:

x-gd-apiversion: 1.0
Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:RXfCFSHfdzZWb6zs8NsKf4DEaKs=
Content-Length: 44
Connection: close
Date: Thu, 19 May 2016 03:53:06 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0

响应示列

HTTP/1.1 200 OK

Header：

Content-Length: 512
x-gd-requestid': 573d38a21315e000171b2bad
Server: nginx/1.4.6
Connection: keep-alive
Content-Type: application/json;charset=utf-8

Body：
{
    "jobs": [
        {
            "status": "success",
            "job_id": "573c35911315e0000159c5f3_573c35911315e000163b3950_samtools_stats_1_3_5_g664cc5fNode2",
            "task_id": "573c35911315e0000159c5f3",
            "startTime": 1463563716.348181,
            "deps": ["573c35911315e0000159c5f3_573c35911315e000163b3950_plot_bamstatsNode3"]
            "endTime": 1463563935.835199,
            "app_name": "samtools stats 1.3-5-g664cc5f"
        },
        {
            "status": "success",
            "job_id": "573c35911315e0000159c5f3_573c35911315e000163b3950_plot_bamstatsNode3",
            "task_id": "573c35911315e0000159c5f3",
            "startTime": 1463564188.597419,
            "deps": []
            "endTime": 1463564474.455225,
            "app_name": "plot-bamstats"
        }
    ]
}

GetJob

获取指定task下指定job的详细信息

请求语法

GET /accounts/<account_name>/projects/<project_name>/tasks/<task_id>/jobs/<job_id>/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

无特定请求参数

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

GetJob请求成功，其响应的Body会包括当前job的详细信息，具体格式如下

属性名称 类型 描述
job_id string Job的唯一标识
tool_name string Job使用工具的名称
status string Job的状态
startTime DateTime Job开始时间
endTime DateTime Job结束时间
Log_downloadURL string 该Job对应日志的 URL
log string 该Job对应日志的前 100KB 字符串

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码。

HTTP状态码 错误码 错误信息 描述
404 JobNotFound Get job failed 获取job详情失败

请求示例

GET /accounts/genedock/projects/default/tasks/573c35911315e0000159c5f3/jobs/573c35911315e0000159c5f3_573c35911315e000163b3950_samtools_stats_1_3_5_g664cc5fNode2/ HTTP/1.1

Header:

x-gd-apiversion: 1.0
Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:RXfCFSHfdzZWb6zs8NsKf4DEaKs=
Content-Length: 44
Connection: close
Date: Thu, 19 May 2016 03:53:06 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0

响应示列

HTTP/1.1 200 OK

Header：

Content-Length: 512
x-gd-requestid': 573d38a21315e000171b2bad
Server: nginx/1.4.6
Connection: keep-alive
Content-Type: application/json;charset=utf-8

Body：
{
    "status": "success",
    "job_id": "573c35911315e0000159c5f3_573c35911315e000163b3950_samtools_stats_1_3_5_g664cc5fNode2",
    "startTime": 1463563716.348181,
    "endTime": 1463563935.835199,
    "tool_name": "samtools stats 1.3-5-g664cc5f",
    "Log_downloadURL": "https://xxxx",
    "log": "hello"
}
上一页下一页